Skip to content

Remove x-pack/metricbeat/module/openai (OpenAI) module and related links #47840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Remove x-pack/metricbeat/module/openai (OpenAI) module and related links #47840

wants to merge 8 commits into from
+0 −2,076

Conversation

@shmsr
Copy link
Member

@shmsr shmsr commented Dec 1, 2025 •
edited
Loading

Proposed commit message

Please note that this module is being removed directly without deprecating. Please read the explanation below

We do not support this OpenAI module; in fact, we never actually utilized it. Our initial plan was to use this module for integration, but immediately after we merged it, OpenAI announced their official Usage API. Consequently, we developed the solution in CEL instead. The CEL approach allows us to iterate faster and makes updates easier to deploy.

Although this metricbeat module for OpenAI was originally planned for integrations, this module remained in beta and was never used. We discontinued it right after the release because it relied on querying an undocumented API for metrics, which was previously the only option. With the new official API now available, we are removing this unauthorized workaround. Users should not use this module, as it is unsupported by us, and the underlying undocumented API is not endorsed or supported by OpenAI.

Please use https://www.elastic.co/docs/reference/integrations/openai instead, which collects metrics from OpenAI's official usage API and is the recommended way to collect metrics from OpenAI.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works. Where relevant, I have used the stresstest.sh script to run them under stress conditions and race detector to verify their stability.
  • I have added an entry in ./changelog/fragments using the changelog tool.

@shmsr shmsr requested review from a team as code owners December 1, 2025 20:04
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Dec 1, 2025
@shmsr shmsr self-assigned this Dec 1, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

🤖 GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@shmsr shmsr added the Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team label Dec 1, 2025
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Dec 1, 2025
@shmsr shmsr requested a review from orestisfl December 1, 2025 20:05
@mergify
Copy link
Contributor

mergify bot commented Dec 1, 2025

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @shmsr? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

orestisfl
orestisfl reviewed Dec 1, 2025
View reviewed changes
Copy link
Contributor

@orestisfl orestisfl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems you forgot: git rm 'docs/reference/metricbeat/metricbeat-metricset-openai-usage.md'

@ishleenk17
Copy link
Member

ishleenk17 commented Dec 2, 2025

@shmsr : any library dependencies that we should remove?

@khushijain21
Copy link
Contributor

khushijain21 commented Dec 2, 2025 •
edited
Loading

Seems you forgot: git rm 'docs/reference/metricbeat/metricbeat-metricset-openai-usage.md'

Also git rm docs/reference/metricbeat/exported-fields-openai.md
and docs/reference/metricbeat/metricbeat-module-openai.md

@shmsr
Copy link
Member Author

shmsr commented Dec 2, 2025

Seems you forgot: git rm 'docs/reference/metricbeat/metricbeat-metricset-openai-usage.md'

Also git rm docs/reference/metricbeat/exported-fields-openai.md and docs/reference/metricbeat/metricbeat-module-openai.md

Done @khushijain21 and @orestisfl!

@shmsr
Copy link
Member Author

shmsr commented Dec 2, 2025

@shmsr : any library dependencies that we should remove?

No only stdlib and elastic libs were used for OpenAI.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025 •
edited
Loading

🔍 Preview links for changed docs

shmsr
shmsr commented Dec 2, 2025
View reviewed changes
@pierrehilbert pierrehilbert added the Team:Docs Label for the Observability docs team label Dec 2, 2025
@shmsr
Copy link
Member Author

shmsr commented Dec 3, 2025

  • @ishleenk17 I need approval on behalf of @elastic/obs-infraobs-integrations
  • Can someone from @elastic/ingest-docs also PTAL?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pierrehilbert pierrehilbert pierrehilbert left review comments

@orestisfl orestisfl orestisfl left review comments

@cmacknz cmacknz cmacknz approved these changes

@khushijain21 khushijain21 khushijain21 approved these changes

@mykola-elastic mykola-elastic mykola-elastic approved these changes

@andrzej-stencel andrzej-stencel Awaiting requested review from andrzej-stencel andrzej-stencel is a code owner automatically assigned from elastic/elastic-agent-data-plane

At least 1 approving review is required to merge this pull request.

Assignees

@shmsr shmsr

Labels

Team:Docs Label for the Observability docs team Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@shmsr @ishleenk17 @khushijain21 @pierrehilbert @cmacknz @orestisfl @mykola-elastic